Offramp
Create payment
Collect & Onramp
- GETRetrieve merchant account balance
- GETRetrieve merchant record
- PATCHUpdate merchant record
- POSTMake a mock payment
- GETRetrieves conversion rates
- GETRetrieve merchant transaction summary
- POSTCreate a new voucher payment
- GETRetrieve voucher record
- GETGet multiple records
- PATCHRedeem existing unused voucher
- PATCHRedeem and withdraw
- GETRetrieves conversion rates
- GETRetrieves minimum and maximum voucher amounts
Offramp
- POSTCreate api key
- POSTCreate payment
- GETGet a single payment
- GETGet a transaction
- GETGet current rates
- GETGet minimum amount allowed
- GETGet supported currencies
- GETGet supported cryptocurrencies and network
- GETResolve overpaid Transaction
- GETRetrieve subscribed webhook url
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- GETRetrieves a user's crypto wallet addresses
- PUTSubscribe to webhook
Payout
- GETGet current rates
- POSTWithdraw balance
- GETGet a transaction
- POSTResolve bank account
- GETGet minimum amount allowed
- GETRetrieve a list of supported banks
- GETRetrieve subscribed webhook url
- GETRetrieve user's account balance
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- PUTSubscribe to webhook
- POSTTransfer funds
- POSTWallet transfer
Offramp
Create payment
Create a new payment
POST
/
payment
curl --request POST \
--url https://staging-biz.coinprofile.co/v2/payment \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--header 'X-User-Version: <api-key>' \
--data '{
"businessId": "<string>",
"reference": "<string>",
"incomingAmount": 123,
"outgoingAmount": 123,
"incomingCurrency": "<string>",
"outgoingCurrency": "<string>",
"rateKey": "<string>",
"customerEmail": "<string>",
"paymentType": "<string>",
"coinprofileUsername": "<string>",
"country": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bank": "<string>",
"bankCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"incomingAmount": 123,
"outgoingAmount": 123,
"confirmedAmount": 123,
"unconfirmedAmount": 123,
"state": "<string>",
"_id": "<string>",
"businessId": "<string>",
"reference": "<string>",
"incomingCurrency": "<string>",
"outgoingCurrency": "<string>",
"expTime": "<string>",
"address": "<string>",
"customerEmail": "<string>",
"paymentType": "<string>",
"account": "<string>",
"rate": 123,
"threadTS": "<string>",
"senderUsername": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
Authorizations
Body
application/json
Response
200 - application/json
successful operation
The response is of type object
.
curl --request POST \
--url https://staging-biz.coinprofile.co/v2/payment \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>' \
--header 'X-User-Version: <api-key>' \
--data '{
"businessId": "<string>",
"reference": "<string>",
"incomingAmount": 123,
"outgoingAmount": 123,
"incomingCurrency": "<string>",
"outgoingCurrency": "<string>",
"rateKey": "<string>",
"customerEmail": "<string>",
"paymentType": "<string>",
"coinprofileUsername": "<string>",
"country": "<string>",
"accountNumber": "<string>",
"accountName": "<string>",
"bank": "<string>",
"bankCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"incomingAmount": 123,
"outgoingAmount": 123,
"confirmedAmount": 123,
"unconfirmedAmount": 123,
"state": "<string>",
"_id": "<string>",
"businessId": "<string>",
"reference": "<string>",
"incomingCurrency": "<string>",
"outgoingCurrency": "<string>",
"expTime": "<string>",
"address": "<string>",
"customerEmail": "<string>",
"paymentType": "<string>",
"account": "<string>",
"rate": 123,
"threadTS": "<string>",
"senderUsername": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}