docsApiRef.baseUrl https://api.kustodia.app/api/v1
docsApiRef.authDesc
X-API-Key: kust_live_tu_clave_aqui/api/v1/paymentsdocsApiRef.ep1Desc
| docsApiRef.parameter | docsApiRef.type | docsApiRef.required | docsApiRef.description |
|---|---|---|---|
| amount | number | docsApiRef.yes | docsApiRef.ep1P1 |
| currency | string | docsApiRef.no | docsApiRef.ep1P2 |
| payer_email | string | docsApiRef.yes | docsApiRef.ep1P3 |
| recipient_email | string | docsApiRef.yes | docsApiRef.ep1P4 |
| description | string | docsApiRef.no | docsApiRef.ep1P5 |
| custody_period_days | integer | docsApiRef.no | docsApiRef.ep1P6 |
| metadata | object | docsApiRef.no | docsApiRef.ep1P7 |
/api/v1/payments/:iddocsApiRef.ep2Desc
/api/v1/paymentsdocsApiRef.ep3Desc
| docsApiRef.parameter | docsApiRef.type | docsApiRef.required | docsApiRef.description |
|---|---|---|---|
| status | string | docsApiRef.no | docsApiRef.ep3P1 |
| limit | integer | docsApiRef.no | docsApiRef.ep3P2 |
| offset | integer | docsApiRef.no | docsApiRef.ep3P3 |
| search | string | docsApiRef.no | docsApiRef.ep3P4 |
/api/v1/payments/:id/statusdocsApiRef.ep4Desc
/api/v1/payments/:id/releasedocsApiRef.ep5Desc
/api/v1/payments/:id/canceldocsApiRef.ep6Desc
/api/v1/payments/:id/simulate-depositdocsApiRef.ep7Desc
docsApiRef.statusPending
docsApiRef.statusProcessing
docsApiRef.statusCustody
docsApiRef.statusPendingRelease
docsApiRef.statusReleased
docsApiRef.statusCancelled
docsApiRef.statusRefunded
docsApiRef.statusDisputed
| docsApiRef.httpCode | docsApiRef.errorType | docsApiRef.errorDesc |
|---|---|---|
| 400 | bad_request | docsApiRef.err400 |
| 401 | unauthorized | docsApiRef.err401 |
| 404 | not_found | docsApiRef.err404 |
| 409 | conflict | docsApiRef.err409 |
| 422 | validation_error | docsApiRef.err422 |
| 500 | server_error | docsApiRef.err500 |