OBN Global API

https://docs.obnglobal.com/
Admin
The OBN Global API provides a RESTful interface for managing merchant applications, payment...
Tokens:12,518
Snippets:94
Trust Score:5.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### GET /ext-ref/merchant-onboarding/mcc-list

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

Retrieves a list of available Merchant Category Codes (MCC) that merchants can select during the onboarding process.

```APIDOC
## GET /{_locale}/ext-ref/merchant-onboarding/mcc-list

### Description
Retrieves a list of available Merchant Category Codes (MCC) for merchants to select during the onboarding process.

### Method
GET

### Endpoint
`/{_locale}/ext-ref/merchant-onboarding/mcc-list`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.

### Responses
#### Success Response (200)
- **data** (object) - Returns the list of MCC objects.

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted.

#### Error Response (500)
- **Error** - Server unavailable.
```

--------------------------------

### GET /websites/obnglobal/{_locale}/{merchantUuid}

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves website-specific information based on the provided locale and merchant identifier.

```APIDOC
## GET /websites/obnglobal/{_locale}/{merchantUuid}

### Description
Retrieves website-specific information, including user preferences and content, tailored to the provided locale and merchant identifier.

### Method
GET

### Endpoint
/websites/obnglobal/{_locale}/{merchantUuid}

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.
- **merchantUuid** (string) - Required - The unique identifier for the merchant.

### Responses
#### Success Response (200)
- **Model** (object) - Contains the website data. Example value: `data`

#### Error Responses
- **403** (object) - Error in content or format of data submitted. Example value: `errors`
- **404** (object) - Requested resource not found. Example value: `errors`
- **500** (object) - Server unavailable. Example value: `Server unavailable and submitted data could not be accepted.`
```

--------------------------------

### Get Transfer Reasons

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves a list of reasons for which funds transfers can be initiated. These reasons provide context for the transfer.

```APIDOC
## GET /{_locale}/ext-ref/payment/transfer/reasons

### Description
Retrieves a list of reasons for which funds transfers can be initiated. These reasons provide context for the transfer.

### Method
GET

### Endpoint
`GET /{_locale}/ext-ref/payment/transfer/reasons`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.

### Responses
#### Success Response (200)
- **data** (object) - Returns success message with transfer reason data.

#### Error Response (403)
- **errors** (object) - Error in content or format of data submitted.

#### Error Response (500)
- Server unavailable.
```

--------------------------------

### GET /payment/disputes

Source: https://docs.obnglobal.com/endpoints/dispute-management

Allows Referrers to query dispute cases at any point during their lifecycle. This endpoint can be used to retrieve information about cases that are in stages such as Pre-Arbitration, Arbitration, or have been identified as Incontestable Disputes.

```APIDOC
## GET /{_locale}/ext-ref/payment/disputes

### Description
At any point during a dispute case, Referrers can use this endpoint to query cases. This includes stages like Pre-Arbitration, Arbitration, and Incontestable Disputes.

### Method
GET

### Endpoint
`/{_locale}/ext-ref/payment/disputes`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request.

#### Query Parameters
*(No specific query parameters are detailed in the provided text, but typically would include parameters for filtering or pagination)*

### Request Example
*(No request body is expected for a GET request)*

### Response
#### Success Response (200)
*(The structure of the success response is not detailed in the provided text, but would typically include a list of dispute case objects)*
```

--------------------------------

### GET /websites/obnglobal/dispute-cases

Source: https://docs.obnglobal.com/endpoints/dispute-management

Retrieves a list of dispute cases based on the provided query parameters. It allows filtering by various attributes such as case ID, merchant ID, status, dates, and more.

```APIDOC
## GET /websites/obnglobal/dispute-cases

### Description
Retrieves a list of dispute cases based on the provided query parameters. It allows filtering by various attributes such as case ID, merchant ID, status, dates, and more.

### Method
GET

### Endpoint
/websites/obnglobal/dispute-cases

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., ‘en-gb’, ‘fr-ca’). If the locale is unavailable, the default English language is returned.

#### Query Parameters
- **caseUuid** (string) - Optional - The unique ID allocated to the dispute case by the Platform.
- **merchantUuid** (string) - Optional - The Merchant’s unique identifier in the Platform.
- **disputeStageUuid** (string) - Optional - The dispute case's current stage unique identifier in the Platform at the time of query.
- **disputeStatusUuid** (string) - Optional - The dispute case's current status unique identifier in the Platform at the time of query.
- **paymentScheme** (string) - Optional - The applicable scheme of the original SALE transaction.
- **createdDate** (string) - Optional - Filter by case creation date (YYYY-MM-DD HH:mm:ss UTC+0).
- **createdDate[before]** (string) - Optional - Filter by case creation date up to this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **createdDate[strictly_before]** (string) - Optional - Filter by case creation date before this date (exclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **createdDate[from]** (string) - Optional - Filter by case creation date from this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **createdDate[strictly_from]** (string) - Optional - Filter by case creation date from this date (exclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeCaseDeadline** (string) - Optional - Filter by the case deadline date (YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeCaseDeadline[before]** (string) - Optional - Filter by case deadline up to this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeCaseDeadline[from]** (string) - Optional - Filter by case deadline from this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeActionDeadline** (string) - Optional - Filter by the action deadline date (YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeActionDeadline[before]** (string) - Optional - Filter by action deadline up to this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **disputeActionDeadline[from]** (string) - Optional - Filter by action deadline from this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **paymentSchemeCreatedDate** (string) - Optional - Filter by the date the payment scheme created the case (YYYY-MM-DD HH:mm:ss UTC+0).
- **paymentSchemeCreatedDate[before]** (string) - Optional - Filter by payment scheme creation date up to this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **paymentSchemeCreatedDate[strictly_before]** (string) - Optional - Filter by payment scheme creation date before this date (exclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **paymentSchemeCreatedDate[from]** (string) - Optional - Filter by payment scheme creation date from this date (inclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **paymentSchemeCreatedDate[strictly_from]** (string) - Optional - Filter by payment scheme creation date from this date (exclusive, YYYY-MM-DD HH:mm:ss UTC+0).
- **limit** (integer) - Optional - The total number of records being requested, subject to a maximum of 250.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
(Response structure not provided in the input text.)

#### Response Example
(Response structure not provided in the input text.)
```

--------------------------------

### Get Transfer Reasons - API Request

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves a list of valid reasons for initiating a transfer. Requires a locale parameter for language-specific results. Handles successful responses (200) and errors (403, 500).

```http
GET /{_locale}/ext-ref/payment/transfer/reasons
```

--------------------------------

### Get Transfer Types

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves a list of available transfer types. These types define the purpose or category of a funds transfer.

```APIDOC
## GET /{_locale}/ext-ref/payment/transfer/types

### Description
Retrieves a list of available transfer types. These types define the purpose or category of a funds transfer.

### Method
GET

### Endpoint
`GET /{_locale}/ext-ref/payment/transfer/types`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.

### Responses
#### Success Response (200)
- **data** (object) - Returns success message with transfer type data.

#### Error Response (403)
- **errors** (object) - Error in content or format of data submitted.

#### Error Response (500)
- Server unavailable.
```

--------------------------------

### Get Merchant Account Details

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves account details for a specific merchant within a Referrer's portfolio, necessary for initiating funds transfers.

```APIDOC
## GET /{_locale}/ext-ref/payment/merchant-account/{merchantUuid}

### Description
Retrieves account details for a specific merchant within a Referrer's portfolio, necessary for initiating funds transfers.

### Method
GET

### Endpoint
`GET /{_locale}/ext-ref/payment/merchant-account/{merchantUuid}`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.
- **merchantUuid** (string) - Required - The unique identifier of the merchant whose account details are being requested.

### Responses
#### Success Response (200)
- **(Response details will vary based on actual implementation)** - Returns the account details for the specified merchant.

#### Error Response (Specific codes and descriptions depend on implementation)
- Potential errors include invalid merchant UUID, insufficient permissions, or server issues.
```

--------------------------------

### Get Transfer Types - API Request

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves a list of valid reasons for initiating a transfer. Requires a locale parameter for language-specific results. Handles successful responses (200) and errors (403, 500).

```http
GET /{_locale}/ext-ref/payment/transfer/types
```

--------------------------------

### List Merchant Category Codes (MCC) API Endpoint

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

This GET endpoint retrieves a list of available Merchant Category Codes (MCC) for API interaction. It requires a locale parameter to set the language of the response. Successful responses return a list of MCC objects, while errors indicate issues with the request or server availability.

```HTTP
GET /{_locale}/ext-ref/merchant-onboarding/mcc-list

Parameters:
_locale (string, required): Sets the language for API interaction and responses (e.g., 'en-gb').
```

--------------------------------

### Get Merchant Account Details - API Request

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Retrieves the account details for a specific merchant within the Referrer's portfolio, necessary for executing fund transfers. Requires the merchant's UUID and a locale parameter. Handles potential errors.

```http
GET /{_locale}/ext-ref/payment/merchant-account/{merchantUuid}
```

--------------------------------

### POST /ext-ref/merchant-onboarding/{applicationUuid}

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

Submits the merchant application information, including business details, management, ownership, and payments. This is a key step in the merchant onboarding data flow.

```APIDOC
## POST /{_locale}/ext-ref/merchant-onboarding/{applicationUuid}

### Description
Submits merchant application information including business details, management, ownership, and payments. This endpoint progresses the application to the 'In Review' status.

### Method
POST

### Endpoint
`/{_locale}/ext-ref/merchant-onboarding/{applicationUuid}`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.
- **applicationUuid** (string) - Required - Merchant application's unique identifier.

#### Request Body
- **business** (object) - Required - Business details.
- **management** (object) - Required - Management information.
- **ownership** (object) - Required - Ownership details.
- **payments** (object) - Required - Payment information.
- **bankDetails** (object) - Optional - Bank details.

### Responses
#### Success Response (200)
- **data** (object) - Returns the saved merchant onboarding information.

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted.

#### Error Response (404)
- **errors** (object) - Requested resource not found.

#### Error Response (422)
- **errors** (object) - One or more internal validations failed. Review response details for retry permissions.

#### Error Response (500)
- **Error** - Server unavailable.
```

--------------------------------

### PUT /ext-ref/merchant-onboarding/commercial-offer/{applicationUuid}

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

Allows referrers to submit the merchant's response to a commercial offer as part of the onboarding data flow. Accepted offers lead to 'Completed' status.

```APIDOC
## PUT /{_locale}/ext-ref/merchant-onboarding/commercial-offer/{applicationUuid}

### Description
Submits the merchant's response to a commercial offer. If accepted, the application status will eventually change to 'Completed'.

### Method
PUT

### Endpoint
`/{_locale}/ext-ref/merchant-onboarding/commercial-offer/{applicationUuid}`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. Format: xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.
- **applicationUuid** (string) - Required - Merchant application's unique identifier.

### Responses
#### Success Response (200)
- **Success** - Indicates the commercial offer response was successfully processed.

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted.

#### Error Response (404)
- **errors** (object) - Requested resource not found.

#### Error Response (500)
- **Error** - Server unavailable.
```

--------------------------------

### Initiate Merchant Onboarding

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

Initiates the merchant onboarding process by creating a new merchant entity and returning a unique application UUID.

```APIDOC
## POST /{_locale}/ext-ref/merchant-onboarding

### Description
Initiates the merchant onboarding process. This is the first step where the Referrer expresses an intention to create a new Merchant entity. A unique identifier (uuid) will be allocated to the applicant Merchant entity and returned to the Referrer for subsequent onboarding steps. If an application is rejected, a new application UUID will be required for resubmission.

### Method
POST

### Endpoint
`/{_locale}/ext-ref/merchant-onboarding`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., 'en-gb', 'fr-ca'). If unavailable, default English is returned.

#### Request Body
(Not specified in documentation)

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier for the created Merchant application.

#### Error Response (400)
- **errors** (object) - Details about content or format errors in the submitted data.

#### Error Response (500)
- Server unavailable.
```

--------------------------------

### Referrer Endpoint Configuration

Source: https://docs.obnglobal.com/notifications

Instructions for Referrers on how to provide an endpoint URL for receiving webhook notifications.

```APIDOC
## Referrer Endpoint Creation

### Description
To receive notifications from the Platform, Referrers must provide their endpoint URL. This is crucial for receiving event-driven or scheduled updates regarding Merchants, especially when direct API integration is used instead of the Portal UI.

### Action
Referrers need to provide their designated endpoint address to the Operator before onboarding their first Merchant.
```

--------------------------------

### POST /websites/obnglobal

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

This endpoint is used to submit application details as part of the merchant onboarding process. It requires information about the applicant.

```APIDOC
## POST /websites/obnglobal

### Description
Submits application details as part of the merchant onboarding process. It requires information about the applicant.

### Method
POST

### Endpoint
/websites/obnglobal

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., ‘en-gb’, ‘fr-ca’). Defaults to English if unavailable.
- **applicationUuid** (string) - Required - Merchant application's unique identifier.

#### Query Parameters
None

#### Request Body
- **isAccepted** (boolean) - Required - Indicates acceptance of terms.
- **applicantIp** (string) - Required - The IP address of the applicant.
- **applicantGeolocation** (object) - Required - Geolocation data of the applicant.
- **applicantTcVersion** (string) - Required - Version of the terms and conditions accepted by the applicant.
- **applicantSignatoryName** (string) - Optional - Name of the signatory.
- **applicantSignatoryRole** (string) - Optional - Role of the signatory.
- **approvalDate** (string) - Optional - Date of approval.
- **externalSignedOffer** (string) - Optional - Path to the externally signed offer.

### Request Example
```json
{
  "isAccepted": true,
  "applicantIp": "192.168.1.1",
  "applicantGeolocation": {
    "latitude": 51.5074,
    "longitude": 0.1278
  },
  "applicantTcVersion": "v1.0",
  "applicantSignatoryName": "John Doe",
  "applicantSignatoryRole": "CEO",
  "approvalDate": "2023-10-27T10:00:00Z",
  "externalSignedOffer": "/path/to/signed/offer.pdf"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains response data.
- **message** (string) - Success message: "The submission was successful."

#### Response Example
```json
{
  "data": {},
  "message": "The submission was successful."
}
```

#### Error Response (400)
- **errors** (object) - Contains error details.
  Description: Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (500)
Server unavailable and submitted data could not be accepted.
```

--------------------------------

### POST /ext-ref/login

Source: https://docs.obnglobal.com/endpoints/authentication

Authenticates the organization using provided API keys and returns an authentication token. The token is valid for 15 minutes and must be included in the Authorization header for subsequent API requests.

```APIDOC
## POST /{_locale}/ext-ref/login

### Description
Authenticates an organization using API keys and returns a temporary authentication token.

### Method
POST

### Endpoint
`POST /{_locale}/ext-ref/login`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., ‘en-gb’, ‘fr-ca’). If unavailable, the default English is returned.

#### Request Body
- **apiKey** (string) - Required - The API key assigned to the organization.
- **apiSecret** (string) - Required - The API secret associated with the API key.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY",
  "apiSecret": "YOUR_API_SECRET"
}
```

### Response
#### Success Response (200)
- **token** (string) - The authentication token for subsequent API calls.

#### Response Example
```json
{
  "token": "generated_auth_token"
}
```

#### Error Responses
- **400**: Bad Request - Error in the content or format of the submitted data.
- **500**: Internal Server Error - The server is unavailable and could not accept the submitted data.
```

--------------------------------

### POST /ext-ref/payment/external-bank-account/{merchantUuid}

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

As the final part of the Merchant onboarding data flow, this endpoint is used by Referrers to send the Merchant's settlement bank account details ready for the first settlement to be made. The merchantUuid must be used, not the applicationUuid.

```APIDOC
## POST /{_locale}/ext-ref/payment/external-bank-account/{merchantUuid}

### Description
Submits the Merchant's settlement bank account details for the first settlement. Requires the merchantUuid.

### Method
POST

### Endpoint
`POST /{_locale}/ext-ref/payment/external-bank-account/{merchantUuid}`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., ‘en-gb’, ‘fr-ca’). Defaults to English if unavailable.
- **merchantUuid** (string) - Required - Merchant's unique identifier.

#### Query Parameters
None

#### Request Body
- **sortCode** (string) - Required - The sort code of the bank account.
- **accountNumber** (string) - Required - The account number.
- **name** (string) - Required - The name on the bank account.
- **country** (string) - Optional - The country of the bank account.
- **currency** (string) - Optional - The currency of the bank account.
- **bankProofPath** (string) - Optional - Path to the bank proof document.

### Request Example
```json
{
  "sortCode": "112233",
  "accountNumber": "9876543210",
  "name": "Merchant Name",
  "country": "GB",
  "currency": "GBP",
  "bankProofPath": "/path/to/bank/proof.pdf"
}
```

### Response
#### Success Response (200)
- **data** (object) - Returns the saved account data.

#### Response Example
```json
{
  "data": {
    "sortCode": "112233",
    "accountNumber": "9876543210",
    "name": "Merchant Name",
    "country": "GB",
    "currency": "GBP"
  }
}
```

#### Error Response (400)
- **errors** (object) - Contains error details.
  Description: Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (404)
- **errors** (object) - Contains error details.
  Description: Requested resource not found. Please review your request and resubmit.

#### Error Response (500)
Server unavailable and submitted data could not be accepted.
```

--------------------------------

### POST /websites/obnglobal

Source: https://docs.obnglobal.com/endpoints/dispute-management

Submit details for a dispute case, including challenge reasons and amounts. The locale parameter sets the language for the interaction.

```APIDOC
## POST /websites/obnglobal

### Description
Submit details for a dispute case, including challenge reasons and amounts. The locale parameter sets the language for the interaction.

### Method
POST

### Endpoint
/websites/obnglobal

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy, where xx is the 2 letter ISO 639 Language Code and yy is the 2 letter ISO 3166-1 country code. For example, ‘en-gb’ for UK English, ‘fr-ca’ for Canadian French. If the locale is unavailable, the default English language is returned.
- **caseUuid** (string) - Required - The unique ID allocated to the dispute case by the Platform.

#### Request Body
- **merchantChallengeResponseReasonCode** (object) - Required - The reason code for the merchant's challenge.
- **merchantChallengeResponseDetail** (string) - Optional - Detailed explanation for the merchant's challenge.
- **challengeDisputedAmount** (object) - Required - The amount being disputed by the challenge.
- **challengeAdditionalCompensationAmount** (object) - Optional - Any additional compensation amount requested.
- **disputeFundsCreditAccountUuid** (string) - Optional - The UUID of the account where dispute funds should be credited.
- **disputeFeesCreditAccountUuid** (string) - Optional - The UUID of the account where dispute fees should be credited.
- **disputeDocumentPath** (string) - Optional - Path to any supporting documents for the dispute.

### Request Example
```json
{
  "_locale": "en-gb",
  "caseUuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "body": {
    "merchantChallengeResponseReasonCode": {},
    "merchantChallengeResponseDetail": "Customer claims item not received.",
    "challengeDisputedAmount": {},
    "challengeAdditionalCompensationAmount": {},
    "disputeFundsCreditAccountUuid": "f1e2d3c4-b5a6-0987-6543-210fedcba987",
    "disputeFeesCreditAccountUuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "disputeDocumentPath": "/documents/dispute/12345.pdf"
  }
}
```

### Response
#### Success Response (200)
- **data** (object) - Returns the payload related to the successful submission.

#### Response Example
```json
{
  "data": {
    "message": "Dispute case updated successfully."
  }
}
```

#### Error Response (400)
- **errors** (object) - Indicates an error in the content or format of the submitted data. Please review the submission against the described requirements and submit again.

#### Error Response (403)
- **errors** (object) - Indicates an error in the content or format of the submitted data. Please review the submission against the described requirements and submit again.

#### Error Response (500)
- Server unavailable and submitted data could not be accepted.
```

--------------------------------

### Respond to Commercial Offer API Endpoint

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

This PUT endpoint allows Referrers to send a Merchant's response to a commercial offer. It requires the locale and the application UUID. Upon acceptance of the offer, the application status will eventually change to 'Completed'.

```HTTP
PUT /{_locale}/ext-ref/merchant-onboarding/commercial-offer/{applicationUuid}

Parameters:
_locale (string, required): Sets the language for API interaction and responses (e.g., 'en-gb').
applicationUuid (string, required): Merchant application's unique identifier.
```

--------------------------------

### POST /ext-ref/login - User Authentication

Source: https://docs.obnglobal.com/endpoints

Authenticates an organization user using API keys and returns an authentication token. This token is required for subsequent API calls and expires after 15 minutes.

```APIDOC
## POST /{_locale}/ext-ref/login

### Description
Authenticates an organization user using API keys and returns an authentication token. This token is required for subsequent API calls and expires after 15 minutes.

### Method
POST

### Endpoint
`POST /{_locale}/ext-ref/login`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy, where xx is the 2 letter ISO 639 Language Code and yy is the 2 letter ISO 3166-1 country code. For example, ‘en-gb’ for UK English, ‘fr-ca’ for Canadian French. If the locale is unavailable, the default English language is returned.

#### Request Body
- **apiKey** (string) - Required - The API key for authentication.
- **apiSecret** (string) - Required - The API secret for authentication.

### Request Example
```json
{
  "apiKey": "your_api_key",
  "apiSecret": "your_api_secret"
}
```

### Response
#### Success Response (200)
- **token** (string) - The authentication token. This token should be included in the `Authorization` header for subsequent API requests.

#### Response Example
```json
{
  "token": "your_authentication_token"
}
```

#### Error Responses
- **400**: Bad Request - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.
- **500**: Internal Server Error - Server unavailable and submitted data could not be accepted.
```

--------------------------------

### POST /{_locale}/ext-ref/payment/transfer

Source: https://docs.obnglobal.com/endpoints/funds-transfer

Initiates a funds transfer between accounts, facilitating payment processing.

```APIDOC
## POST /{_locale}/ext-ref/payment/transfer

### Description
This endpoint is used for creating a funds transfer between specified accounts. It requires details about the source, destination, amount, and initiator of the transfer.

### Method
POST

### Endpoint
/{_locale}/ext-ref/payment/transfer

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., 'en-gb', 'fr-ca'). Defaults to English if unavailable.

#### Request Body
- **reason** (string) - Required - The reason for the transfer.
- **sourceAccountReference** (string) - Required - The reference identifier for the source account.
- **destinationAccountReference** (string) - Required - The reference identifier for the destination account.
- **amount** (number) - Required - The amount to be transferred.
- **description** (string) - Optional - A description for the transfer.
- **initiator** (string) - Required - Information about the initiator of the transfer.
- **initiatorContact** (string) - Required - Contact details of the initiator.
- **initiatorReferenceId** (string) - Required - A reference ID for the initiator.
- **obnTransactionUuid** (string) - Optional - The Open Banking transaction UUID.

### Responses
#### Success Response (200)
- **Model** (object) - Returns success message. Example value: `data`

#### Error Responses
- **403** (object) - Error in content or format of data submitted. Example value: `errors`
- **500** (object) - Server unavailable. Example value: `Server unavailable and submitted data could not be accepted.`
```

--------------------------------

### Submit Merchant Application API Endpoint

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

This POST endpoint submits merchant application information, including business details, management, ownership, and payments. It requires the locale and a unique application UUID. The request body should contain structured data for these sections. Responses indicate success, data errors, or resource not found.

```HTTP
POST /{_locale}/ext-ref/merchant-onboarding/{applicationUuid}

Parameters:
_locale (string, required): Sets the language for API interaction and responses (e.g., 'en-gb').
applicationUuid (string, required): Merchant application's unique identifier.
body (object, required): Contains business, management, ownership, payments, and bankDetails information.
```

--------------------------------

### Upload Merchant Documents

Source: https://docs.obnglobal.com/endpoints/merchant-onboarding

Uploads supporting documents for a merchant application. Documents are uploaded one by one and must not exceed 15MB. Accepted formats are jpeg, png, and pdf.

```APIDOC
## POST /{_locale}/ext-ref/merchant-onboarding/documents/{applicationUuid}

### Description
On a case-by-case basis, this endpoint allows uploading supporting documents for a merchant application (e.g., proof of ID). Documents should be uploaded individually. A unique name is returned after each successful upload, which should be saved for future steps. Documents must not exceed 15MB and can only be in jpeg, png, or pdf format. The request should use FormData objects with key/value pairs.

### Method
POST

### Endpoint
`/{_locale}/ext-ref/merchant-onboarding/documents/{applicationUuid}`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses. The format is xx-yy (e.g., 'en-gb', 'fr-ca'). If unavailable, default English is returned.
- **applicationUuid** (string) - Required - The unique identifier for the merchant application.

#### Query Parameters
(Not specified in documentation)

#### Request Body
- **file** (FormData) - Required - The document file to upload. Accepts jpeg, png, and pdf formats, with a maximum size of 15MB.

### Response
#### Success Response (200)
- **fileName** (string) - The name of the uploaded document.
- **url** (string) - The URL where the uploaded document can be accessed.

#### Error Response (400)
- **errors** (object) - Details about content or format errors in the submitted data.

#### Error Response (500)
- Server unavailable.
```

--------------------------------

### API Login Endpoint

Source: https://docs.obnglobal.com/endpoints/authentication

This snippet shows the structure of the POST request to the login endpoint for API authentication. It includes the endpoint path and describes the required parameters.

```HTTP
POST /{_locale}/ext-ref/login
```

--------------------------------

### Webhook Notification Structure

Source: https://docs.obnglobal.com/notifications

Details the structure of webhook notifications sent by the Platform to Referrer endpoints.

```APIDOC
## POST /webhook

### Description
Webhooks are used by the Platform to notify Referrers of changes to their Merchants' status or data throughout the Merchant lifecycle.

### Method
POST

### Endpoint
(Platform sends to Referrer's configured endpoint)

### Request Body
- **name** (string) - Required - The name of the webhook event (always in uppercase).
- **data** (object) - Required - The payload containing specific information for the webhook event.

### Headers
- **Content-Type**: application/json; charset=utf-8
- **Accept**: application/json
- **X-Signature**: {Referrer specific hash string} - A base64 encoded HMAC-SHA256 hash of the Referrer's API key, used for request verification.

### Request Example
```json
{
  "name": "MERCHANT_STATUS_UPDATED",
  "data": {
    "merchantId": "MERCH123",
    "status": "APPROVED",
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of receiving the webhook.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Upload Dispute Case Document API

Source: https://docs.obnglobal.com/endpoints/dispute-management

Uploads supporting documents for a specific dispute case. Documents should be uploaded one by one and must not exceed 5MB. Accepted file types are jpeg, png, and pdf.

```APIDOC
## POST /{_locale}/ext-ref/payment/dispute/{caseUuid}/documents

### Description
On a case-by-case basis, some dispute cases may require supporting documents to be uploaded. Such documents should be uploaded one by one, with a unique name being returned after each successful attempt. These names should be saved and used in the next steps. For documents uploading the FormData objects, a list of key/value pairs should be provided with the submission. The document should not be more than 5MB in size and only jpeg/png/pdf files are accepted.

### Method
POST

### Endpoint
`/{_locale}/ext-ref/payment/dispute/{caseUuid}/documents`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses, where available. The format is xx-yy, where xx is the 2 letter ISO 639 Language Code and yy is the 2 letter ISO 3166-1 country code. For example, ‘en-gb’ for UK English, ‘fr-ca’ for Canadian French. If the locale is unavailable, the default English language is returned.
- **caseUuid** (string) - Required - The unique ID allocated to the dispute case by the Platform.

#### Request Body
- **file** (file) - Required - File input. The document should not be more than 5MB in size and only jpeg/png/pdf files are accepted.

### Responses
#### Success Response (200)
- **data** (object) - Returns the file name of the uploaded document.

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (403)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (500)
- **error** (string) - Server unavailable and submitted data could not be accepted.
```

--------------------------------

### Dispute Response Accept API

Source: https://docs.obnglobal.com/endpoints/dispute-management

Accepts liability for a specific dispute case. This action confirms the merchant's responsibility for the dispute and any claimed compensation.

```APIDOC
## PUT /{_locale}/ext-ref/payment/dispute/{caseUuid}/accept

### Description
This endpoint is used for the merchant to accept liability for a specific dispute case, including any additional compensation that might have also been claimed. To challenge liability in a dispute case, the Dispute response challenge should be used.

### Method
PUT

### Endpoint
`/{_locale}/ext-ref/payment/dispute/{caseUuid}/accept`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses, where available. The format is xx-yy, where xx is the 2 letter ISO 639 Language Code and yy is the 2 letter ISO 3166-1 country code. For example, ‘en-gb’ for UK English, ‘fr-ca’ for Canadian French. If the locale is unavailable, the default English language is returned.
- **caseUuid** (string) - Required - The unique ID allocated to the dispute case by the Platform.

### Responses
#### Success Response (200)
- **message** (string) - Returns success message

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (403)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (500)
- **error** (string) - Server unavailable and submitted data could not be accepted.
```

--------------------------------

### API Login Endpoint (POST)

Source: https://docs.obnglobal.com/endpoints

This snippet shows the POST endpoint used for API authentication. It requires the locale as a path parameter and expects API key and secret in the request body. Successful authentication returns a token.

```HTTP
POST /{_locale}/ext-ref/login

{ "apiKey": "your_api_key", "apiSecret": "your_api_secret" }
```

--------------------------------

### Dispute Response Challenge API

Source: https://docs.obnglobal.com/endpoints/dispute-management

Challenges liability for a specific dispute case. This action allows the merchant to contest the dispute and any claimed compensation.

```APIDOC
## PUT /{_locale}/ext-ref/payment/dispute/{caseUuid}/challenge

### Description
This endpoint is used for the merchant to challenge liability for a specific dispute cases, including any additional compensation that might have also been claimed. To accept liability in a dispute case, the Dispute response accept should be used.

### Method
PUT

### Endpoint
`/{_locale}/ext-ref/payment/dispute/{caseUuid}/challenge`

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Sets the language for API interaction and responses, where available. The format is xx-yy, where xx is the 2 letter ISO 639 Language Code and yy is the 2 letter ISO 3166-1 country code. For example, ‘en-gb’ for UK English, ‘fr-ca’ for Canadian French. If the locale is unavailable, the default English language is returned.
- **caseUuid** (string) - Required - The unique ID allocated to the dispute case by the Platform.

### Responses
*(Note: Specific success and error response details for this endpoint were not fully provided in the input text. The following are placeholders based on common API patterns.)*
#### Success Response (200)
- **message** (string) - Returns success message confirming the challenge.

#### Error Response (400)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (403)
- **errors** (object) - Error in content or format of data submitted. Please review the submission against the described requirements and submit again.

#### Error Response (500)
- **error** (string) - Server unavailable and submitted data could not be accepted.
```
Tokens:
Raw