Payments
Create off-ramp transfer
Creates an off-ramp transfer (crypto to fiat)
X-API-KEY<token>
API key for authentication (prefix: sk_dev_ for development, sk_live_ for production)
In: header
Path Parameters
recipientIdstring
Recipient ID
Format
uuidreferenceId?string
Format
uuididempotencyKeystring
Length
length <= 255quoteIdstring
Format
uuidbankAccountIdstring
Format
uuidfromAddressstring
paymentReasonstring
Value in
"TRANSFER_TO_SELF" | "CAPITAL_CONTRIBUTIONS" | "CHARITABLE_CONTRIBUTIONS" | "CONSULTING_FEES" | "CORPORATE_TAX_PAYMENTS" | "DOWN_PAYMENTS_FOR_REAL_ESTATE" | "EDUCATION_FEES" | "EMPLOYEE_SALARIES_OR_WAGES" | "EXPENSES_REIMBURSEMENT" | "GIFTS" | "GOVERNMENT_GRANTS" | "INCOME_TAX_PAYMENTS" | "INHERITANCE_PAYMENTS" | "INSURANCE_CLAIM_PAYOUTS" | "INSURANCE_PREMIUM_PAYMENTS" | "INVESTMENTS" | "LOAN_ADVANCES" | "MORTGAGE_PAYMENTS" | "OTHER" | "PAYMENT_FOR_GOODS_AND_SERVICES" | "PERSONAL_TRANSFERS" | "REAL_ESTATE_PURCHASES" | "REMITTANCES" | "RENT" | "REPAYMENT_OF_LOANS" | "ROYALTIES" | "TRUST_FUND_DISTRIBUTIONS" | "UTILITY_BILLS" | "WELFARE_OR_BENEFITS" | "WINNINGS_AND_PRIZES"files?array<string>
documentReference?string
Length
length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.sentra.xyz/api/v1/payments/recipient/497f6eca-6276-4993-bfeb-53cbbbba6f08/off-ramp" \ -H "Content-Type: application/json" \ -d '{ "idempotencyKey": "string", "quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7", "bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857", "fromAddress": "string", "paymentReason": "TRANSFER_TO_SELF" }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"idempotencyKey": "string",
"type": "ON_RAMP",
"status": "AWAITING_FUNDS",
"quoteId": "826e5192-f8c6-4e24-aab3-3910e46c52b7",
"bankAccountId": "5b26b598-a880-4e32-8c41-126aa0206857",
"walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
"transactionHash": "string",
"fee": 0,
"reason": "string",
"documentReference": "string",
"files": [
"string"
],
"sourceAccount": "string",
"metadata": {},
"createdAt": "2019-08-24T14:15:22Z",
"sentAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z"
}{
"message": "Validation failed",
"statusCode": 400,
"details": {
"field": "email",
"message": "Invalid email format"
}
}{
"message": "Unauthorized",
"statusCode": 401
}{
"message": "Resource not found",
"statusCode": 404
}{
"message": "Internal server error",
"statusCode": 500
}