ALalfredpay
Endorsements

Request an endorsement

Changed on

Asks for an entitlement. The customer has to be ACTIVE, otherwise the endorsement parks at INCOMPLETE.

For fiat_collection this request is what triggers provisioning. Wait for customer.endorsement.updated to reach APPROVED before you call the instrument endpoint, not the other way round.

Wait on customer.endorsement.updated reaching APPROVED. See Webhooks and events.

post/v1/customers/{customerId}/endorsements

Request

  • Base URL
    https://api.sandbox.alfredpay.io
  • URL
    https://api.sandbox.alfredpay.io/v1/customers/{customerId}/endorsements
  • Auth
    • HTTP bearer
    • or API key in header api-key and API key in header api-secret

Headers

Idempotency-Keystring uuid required

Required on every state-changing POST, simulators included; the only exempt POST is …/verifications/preflight. Replay (same key, same body) returns the original response with Idempotent-Replayed: true; same key with a different body → 409 idempotency_conflict. Keys are UUIDs, scoped to the API key, retained for 24 hours.

Request body

endorsement'stablecoin_balance' | 'stablecoin_payin' | 'fiat_collection' | 'fiat_payout.cross_border' | 'stablecoin_payout.third_party' | 'corporate_usd_account' | 'local_stablecoin.MXNa' | 'local_stablecoin.ARSa' | 'local_stablecoin.COPa' | 'local_stablecoin.BRZ' required

Response

Accepted

endorsement'stablecoin_balance' | 'stablecoin_payin' | 'fiat_collection' | 'fiat_payout.cross_border' | 'stablecoin_payout.third_party' | 'corporate_usd_account' | 'local_stablecoin.MXNa' | 'local_stablecoin.ARSa' | 'local_stablecoin.COPa' | 'local_stablecoin.BRZ'
endorsement_status'INCOMPLETE' | 'APPROVED' | 'PAUSED' | 'REVOKED'
reason_code'kyc_incomplete' | 'provider_processing' | 'null' nullable
next_action'none' | 'provide_information'

Changes