Submit a pooled bank payin quote

Execute a Swipelux payin quote and return payment instructions.

POST /api/v1/banks/payin/quote/submit

Submit a pooled bank payin quote

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/banks/payin/quote/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quoteId": "<string>"
}
'

import requests

url = "https://api.hevn.finance/api/v1/banks/payin/quote/submit"

payload = { "quoteId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({quoteId: '<string>'})
};

fetch('https://api.hevn.finance/api/v1/banks/payin/quote/submit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "quoteId": "<string>",
  "bankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resource": "<string>",
  "recipientDetails": {
    "bankName": "<string>",
    "ibanNumber": "<string>",
    "beneficiaryName": "<string>",
    "bankAddress": "<string>",
    "currency": "<string>",
    "accountHolderFirstName": "<string>",
    "accountHolderLastName": "<string>",
    "accountHolderBusinessName": "<string>",
    "accountHolderAddress": {
      "streetAddress": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>"
    },
    "paymentReference": "<string>",
    "accountType": "sepa",
    "bic": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

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

Headers

x-api-key · string | null

Body

application/json

Submit a previously created Swipelux bank payin quote.

quoteId · string · required

Response

200

application/json

Successful Response

Swipelux payin instructions returned after quote submit.

quoteId · string · required

bankAccountId · string<uuid> | null

resource · string | null

recipientDetails · IBANAccountDetails · object

IBAN (SEPA) external account.

IBANAccountDetails

USExternalAccountDetails

SwiftAccountDetails

Show child attributes