Downloads & changelog
Downloads
| File | What it is |
|---|---|
| Postman collection | Every Pay-In request, ready to run: countries, exchange rates, payment methods, create a deposit, get a deposit, re-send a notification and sandbox simulate. |
| Postman environment: sandbox | base_url = https://sandbox-api.cashela.com. |
| Postman environment: production | base_url = https://production-api.cashela.com. |
| Webhook signature test vectors | Cases to test your X-Cashela-Signature check. See Webhooks. |
Using the Postman collection
- Import the collection and the environment you need.
- Fill
partner_keywith your API key andpartner_secretwith your API secret from the Developer Portal.partner_secretis a secret variable: keep it in your local (current) value and do not share or sync it. - Run Get Available Payment Methods first, and use one of the returned
payment_methodcodes in Create Deposit. - Add the payer fields the chosen method requires (
required_fields) to the Create Deposit body (for examplephone,document_key,document_number), with data valid for the deposit’s country. See Payer data & documents. - Set
referenceto the deposit’sreferenceor yourexternal_identifierto run Get Transaction, Resend Callback and, in sandbox, Simulate Final Status.
The collection does not include the void and refund requests. See Voids and refunds.
Versions
The Pay-In API is served under /api/v1/. Its contract version (currently 3.5.0) changes independently of the URL:
- Minor versions (3.4 → 3.5) are additive: new response fields, new error codes, new optional behaviour. Build your integration to ignore fields it does not know.
- Major versions (2.x → 3.0) change something an existing integration can see.
Changelog
3.5.0 (2026-10-19)
- For card options charged in USD, the notification
amount/currencyare the USD charged (for example5.00 USD), not the local-currency invoice. Other methods are unchanged. GET /transactions/{reference}addsdetails.charged_amountanddetails.charged_currency: what the customer was actually charged, the same figure as the notificationamount/currency.details.invoice_*is unchanged and remains the invoice.- Documented: on
DECLINEDandCANCELLED, the notification amounts are the quote, not money that moved.
3.4.0 (2026-10-18)
- Voids and refunds are for card deposits only: other deposits answer
422PARTNER_PAYIN_REVERSAL_NOT_SUPPORTEDand nothing moves. - A full void or refund returns the whole charge to the card and keeps the Cashela fee.
3.3.0 (2026-10-18)
- Each payment method option adds
document_types(accepted documents with their format) andrequired_fields(every field the method requires).
3.2.0 (2026-10-18)
- When the payment network refuses a deposit because of a payer field,
422PARTNER_PAYIN_PROVIDER_REJECTEDnames the field in an optionalprovider_reason.
3.1.0 (2026-10-16)
- A compliance refusal on Get payment methods carries
code: PARTNER_PAYIN_COMPLIANCE_BLOCKED.
3.0.0 (2026-10-15)
- Breaking:
card.networkis the lowercase network code (visa,mastercard,discover,amex), ornullwhen unknown, in both the deposit and the notification.
2.0.0 (2026-10-15)
- Breaking: the success envelope is
success,data,message. Two internal keys it used to carry were removed.
1.6.0 (2026-10-14)
- New final status
REVERSEDfor a completed deposit whose money went back in full. - Validation
422responses also carrysuccess: false(status: falseis kept as a deprecated alias).
1.5.0 (2026-10-13)
- Payment method options may carry
availability; a deposit on an unavailable method answers422PARTNER_PAYIN_ROUTE_UNAVAILABLE.
1.4.0 (2026-10-07)
- New sandbox-only endpoint to drive a deposit to a final status:
POST /sandbox/transactions/{reference}/simulate.
1.3.0 (2026-10-07)
- Production host confirmed as
https://production-api.cashela.com. - Signed notification, signature scheme and test vectors documented.
1.2.0 (2026-10-06)
- The notification adds
card(network,last4) after the existing keys.
1.1.0 (2026-10-05)
- On some accounts, payment method options add
data_standard, and validation errors addfield_errors[].
1.0.0 (2026-09-26)
- Baseline of the Pay-In v1 contract.