payment methods

Manage the method used to pay an employee (Transfer or Cash).

Get Payment Methods

SecuritybearerAuth

Responses

200

Payment Menthod Response - Array

get/paymentMethods

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "employments",
"attributes": {"method": "Transfer",
"payee": "Alan Barr",
"paymentReference": "Salary",
"accountNumber": "01100110",
"sortCode": "01-01-01"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
]
}

Create a Payment Method

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

Payment method to be added.

Business Rules:

method must be either Transfer or Cash
For Transfer: accountNumber and sortCode are required; paymentReference optional
For Cash: accountNumber, sortCode and paymentReference should be omitted or null

object

Responses

201

Payment Menthod Response

post/paymentMethods

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "paymentMethods",
"attributes": {"method": "Transfer",
"payee": "Alan Barr",
"paymentReference": "Salary",
"accountNumber": "01100110",
"sortCode": "01-01-01"
},
"relationships": {"employment": {"data": {"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employments"
}
}
}
}
}

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "paymentMethods",
"attributes": {"method": "Transfer",
"payee": "Alan Barr",
"paymentReference": "Salary",
"accountNumber": "01100110",
"sortCode": "01-01-01"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

Get Payment Method by ID

SecuritybearerAuth

Request

path Parameters

required

string <uuid>

PaymentMethod ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

Payment Menthod Response

get/paymentMethods/{id}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "paymentMethods",
"attributes": {"method": "Transfer",
"payee": "Alan Barr",
"paymentReference": "Salary",
"accountNumber": "01100110",
"sortCode": "01-01-01"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/paymentMethods/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

➔ Next to payment types