Skip to main content
POST
/
v1
/
payouts
/
pop-documents
/
upload-url
Request a presigned upload URL for a SWIFT purpose-of-payment document
curl --request POST \
  --url https://api.example.com/v1/payouts/pop-documents/upload-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "<string>",
  "fileSize": 123
}
'
{
  "documentKey": "pop-documents/cc82fa1d-.../9f1c.../invoice.pdf",
  "uploadUrl": "https://s3.example/pop-documents/...?X-Amz-Signature=..."
}

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Body

application/json
​
fileName
string
required
​
fileSize
number
required
​
mimeType
enum<string>
required
Available options:
application/pdf,
image/jpeg,
image/png

Response

Presigned URL and document key returned

​
documentKey
string
required

Document key to pass as purposeOfPaymentDocumentKey on POST /v1/payouts.

Example:

"pop-documents/cc82fa1d-.../9f1c.../invoice.pdf"

​
uploadUrl
string
required

Presigned S3 PUT URL — upload the document body here.

Example:

"https://s3.example/pop-documents/...?X-Amz-Signature=..."