public

Pointer un règlement reçu

POST

/v1/invoices/{id}/payments

curl --request POST \
  --url '/v1/invoices/{id}/payments' \
  --header 'Authorization: Bearer <token>' \
  --header 'idempotency-key: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "AED",
  "label": "<string>",
  "paidOn": "<string>"
}
'

{
  "amount": 123,
  "bankAccountId": "<string>",
  "currency": "<string>",
  "currencyAmount": 123,
  "currencyFee": 123,
  "fee": 123,
  "id": "<string>",
  "label": "<string>",
  "paidOn": "<string>",
  "provider": "pennylane",
  "recordedAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Autorisations

Authorizationstringheaderobligatoire

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Clé de reprise choisie par le client (8 à 255 caractères). Quand elle est fournie, une reprise portant la même clé et la même charge n’encaisse rien de plus : elle rend le règlement déjà pointé, relu au moment de la reprise. La même clé sur une charge différente est refusée.

Corps

amountnumberobligatoire

Plage requise: 0 < x

currencyenum<string>obligatoire

Options disponibles: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

labelstring | null

Maximum string length: 200

paidOnstring | null

Réponse

amountnumberobligatoire

bankAccountIdstring | nullobligatoire

currencystring | nullobligatoire

currencyAmountnumber | nullobligatoire

currencyFeenumber | nullobligatoire

feenumber | nullobligatoire

idstringobligatoire

Motif: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

labelstring | nullobligatoire

paidOnstring | nullobligatoire

providerenum<string>obligatoire

Options disponibles: pennylane, import, manual

recordedAtstring | nullobligatoire

updatedAtstring | nullobligatoire

Besoin d'aide supplémentaire ? Demander à l'équipe

Pointer un règlement reçu

Autorisations

Paramètres de chemin

En-têtes

Corps

Réponse