The following basic expectations apply for v3 HTTP response scenarios.
| Response Type | Code | Body Message Contents | Details & Example Scenarios |
|---|
| Successful | 200 | Results | - Request is valid and results are returned
- GET History - There are no transactions in filtered criteria
|
| Response Type | Code | Body Message Contents | Details & Example Scenarios |
|---|
| Successful | 200 | Confirmation details | - Duplicate transaction using idempotency
- The request was previously successfully submitted; new record not created
|
| Created | 201 | Confirmation details | - SEN transfer – transfer sent to counterparty
- FX Quote – quote for fx trade returned
- FX Trade – trade booked in Sierra
- Payment – payment created in GPP and pending approval
- Webhook – new webhook created
|
| Response Type | Code | Body Message Contents | Details & Example Scenarios |
|---|
| Successful | 200 | Confirmation details | The action requested succeeded and confirmation details returned |
| Response Type | Code | Body Message Contents | Details & Example Scenarios |
|---|
| Successful | 204 | Null | The delete request succeeded and record no longer exists (No Content) |
| Response Type | Code | Body Message Contents | Details & Example Scenarios |
|---|
| No Content | 204 | null | - There are no results to return
- GET payment - payment_id is not owned or not in a viewable status
|
| Bad Request | 400 | Error message specific to reason (when appropriate) | - Missing required field from query parameter or request body
- PATCH payment - Bad action value (not "Approve", "Cancel" or "Return")
|
| Unauthorized | 401 | Varied | - Required authentication header(s) not provided
- Invalid subscription key or secret
- Spaces in the account number when the account number is a path parameter
- Subscription status is suspended
- PATCH payment - Not permissioned to this payment_id
|
| Forbidden | 403 | "Forbidden" | - Account status in Portal is inactive (contact your account manager)
- Invalid IP address
- Invalid Account Number or unique_id
|
| Not Found | 404 | "Resource not found" | - A path parameter is missing required information
|
| Too Many Requests | 429 | "The subscription's rate limit for this account has been exceeded. Try again in 60 seconds." | - User has sent too many requests in a given amount of time. See Rate Limits for more details.
|
| Server error | 500 | Internal server error | |
| Server error | 503 | Service unavailable | - Application offline/unresponsive
- Service overloaded
|
